Skip to content

Revised text and headers to adhere to style guide #520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 40 commits into from
May 6, 2025
Merged

Conversation

MV1205
Copy link
Contributor

@MV1205 MV1205 commented May 4, 2025

Proposed changes

Problem: Revised the text and the headers of the document to adhere to style guide.

Please focus on (optional): I tried to make the body text easier to read and used sentence case on a few of the sub headings.

If this PR addresses an issue on GitHub, ensure that you link to it here: (#95)

Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

MV1205 added 2 commits May 4, 2025 15:14
Edit the text and titles to adhere to style guide rules.
@MV1205 MV1205 requested a review from a team as a code owner May 4, 2025 23:01
Copy link

github-actions bot commented May 4, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) labels May 4, 2025
@MV1205
Copy link
Contributor Author

MV1205 commented May 4, 2025

I have hereby read the F5 CLA and agree to its terms

@MV1205
Copy link
Contributor Author

MV1205 commented May 5, 2025 via email

Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I apologize for the large number of changes. If you're still at the conference, I'd love to chat in person. If you don't see me, you're welcome to DM me on the Write the Docs slack

@mjang
Copy link
Contributor

mjang commented May 6, 2025

recheck

mjang and others added 19 commits May 5, 2025 17:04
MV1205 and others added 17 commits May 5, 2025 17:44
@MV1205
Copy link
Contributor Author

MV1205 commented May 6, 2025

Hi Mike, I looked at your feedback. I 'Committed' you edits. Please let me know if that was the wrong process. Thank you again for your patience.

@mjang
Copy link
Contributor

mjang commented May 6, 2025

Thanks so much and congratulations on your contribution!

@mjang mjang merged commit bdcccc5 into nginx:main May 6, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants